/*
 * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.graalvm.nativeimage.dynamicaccess;

import org.graalvm.nativeimage.hosted.Feature;

import java.lang.reflect.Executable;
import java.lang.reflect.Field;

/**
 * This interface is used to register classes, methods, and fields for JNI access at runtime. An
 * instance of this interface is acquired via
 * {@link Feature.AfterRegistrationAccess#getJNIAccess()}.
 * <p>
 * All methods in {@link JNIAccess} require a {@link AccessCondition} as their first parameter. A
 * class and its members will be registered for JNI access only if the specified condition is
 * satisfied.
 *
 * <h3>How to use</h3>
 *
 * {@link JNIAccess} should only be used during {@link Feature#afterRegistration}. Any attempt to
 * register metadata in any other phase will result in an error.
 * <p>
 * <strong>Example:</strong>
 *
 * <pre>{@code @Override
 * public void afterRegistration(AfterRegistrationAccess access) {
 *     JNIAccess jniAccess = access.getJNIAccess();
 *     AccessCondition condition = AccessCondition.typeReached(ConditionType.class);
 *     jniAccess.register(condition, Foo.class);
 *     jniAccess.register(condition, Foo.class.getMethod("method"));
 *     jniAccess.register(condition, Foo.class.getField("field"));
 * }
 * }</pre>
 *
 * @see <a href=https://docs.oracle.com/en/java/javase/17/docs/specs/jni/functions.html>Java docs -
 *      JNI functions</a>
 *
 * @since 25.0.1
 */
public interface JNIAccess {
    /**
     * Registers the provided classes for JNI access at run time, if the {@code condition} is
     * satisfied.
     *
     * @since 25.0.1
     */
    void register(AccessCondition condition, Class<?>... classes);

    /**
     * Registers the provided methods for JNI access at run time, if the {@code condition} is
     * satisfied.
     *
     * @since 25.0.1
     */
    void register(AccessCondition condition, Executable... methods);

    /**
     * Registers the provided fields for JNI access at run time, if the {@code condition} is
     * satisfied.
     *
     * @since 25.0.1
     */
    void register(AccessCondition condition, Field... fields);
}
